4.5 Cancelar plano de pagamento

Request

Request

mutation CancelPaymentPlan {
    cancelPaymentPlan(
        data: {
            refId: "fc42ba1b-0059-44a3-8a73-a4ad1e562b12"
            cancellationReason: CONTRACT_CANCELLATION
            cancellationDescription: "Teste cancelamento plano de pagamento"
        }
    ) {
        id
        errorMessage
        canceled
        scheduled
    }
}

Params

Parâmetro	Tipo	Descrição
data	CancelPaymentPlanDataInput!	Dados de Cancelamento do Plano de Pagamento

Objeto CancelPaymentPlanDataInput

Campo	Tipo	Descrição
auditData	AuditDataInput	Dados de auditoria do sistema integrado
cancellationDescription	String	Descrição do Motivo de Cancelamento
cancellationReason	CancellationReason	Motivo de Cancelamento
id	Int	Id do Objeto
manualCancellation	Boolean	Cancelamento Manual
refId	String	Id da Referência
scheduleCancellationIfNotRegistered	Boolean	Em caso de falha ao tentar o cancelamento, o sistema irá marcar a cobrança para ser cancelada posteriormente

Response

Response

{
    "data": {
        "cancelPaymentPlan": [
            {
                "id": "2ffbb41d-43f4-4fba-8d72-1f5bb46127fa",
                "errorMessage": null,
                "canceled": true,
                "scheduled": false
            },
            {
                "id": "652e7aaa-0ca6-4185-b02b-c5f465b619b7",
                "errorMessage": null,
                "canceled": true,
                "scheduled": false
            },
            {
                "id": "7f418ee1-0b08-46b2-9522-70d93074685d",
                "errorMessage": null,
                "canceled": true,
                "scheduled": false
            }
        ]
    }
}

Result

Campo	Tipo	Descrição
cancelPaymentPlan	[CancelPaymentPlanBillingResult!]!	Dados de retorno do cancelamento do plano de pagamento

Objeto CancelPaymentPlanBillingResult

Campo	Tipo	Descrição
billingId	Int	Id único da cobrança
canceled	Boolean!	Cobrança foi cancelada
errorMessage	String	Mensagem de erro (caso ocorra algum problema)
id	UUID!	Id referência da cobrança
scheduled	Boolean!	Cobrança foi agendada para ser cancelada após o registro